Editor: Make asset registration .asset.php optional for blocks #5799

josephfusco · 2023-12-19T19:58:56Z

It is a hard requirement that a *.asset.php file is present to register a block in WordPress. Otherwise, it throws a Warning:

function register_block_script_handle was called incorrectly. The asset file (/wp-content/uploads/faustwp/blocks/block-a/index.asset.php) for the "editorScript" defined in "create-block/block-a" block definition is missing. (This message was added in version 5.5.0.)

and the block will not appear in the inserter.

Trac ticket: https://core.trac.wordpress.org/ticket/60460

Gutenberg issue: WordPress/gutenberg#57234

This Pull Request is for code review only. Please keep all other discussion in the Trac ticket. Do not merge this Pull Request. See GitHub Pull Requests for Code Review in the Core Handbook for more details.

github-actions · 2023-12-19T19:59:11Z

Test using WordPress Playground

The changes in this pull request can previewed and tested using a WordPress Playground instance.

WordPress Playground is an experimental project that creates a full WordPress instance entirely within the browser.

Some things to be aware of

The Plugin and Theme Directories cannot be accessed within Playground.
All changes will be lost when closing a tab with a Playground instance.
All changes will be lost when refreshing the page.
A fresh instance is created each time the link below is clicked.
Every time this pull request is updated, a new ZIP file containing all changes is created. If changes are not reflected in the Playground instance,
it's possible that the most recent build failed, or has not completed. Check the list of workflow runs to be sure.

For more details about these limitations and more, check out the Limitations page in the WordPress Playground documentation.

Test this pull request with WordPress Playground.

github-actions · 2023-12-19T19:59:13Z

Hi @josephfusco! 👋

Thank you for your contribution to WordPress! 💖

It looks like this is your first pull request to wordpress-develop. Here are a few things to be aware of that may help you out!

No one monitors this repository for new pull requests. Pull requests must be attached to a Trac ticket to be considered for inclusion in WordPress Core. To attach a pull request to a Trac ticket, please include the ticket's full URL in your pull request description.

Pull requests are never merged on GitHub. The WordPress codebase continues to be managed through the SVN repository that this GitHub repository mirrors. Please feel free to open pull requests to work on any contribution you are making.

More information about how GitHub pull requests can be used to contribute to WordPress can be found in this blog post.

Please include automated tests. Including tests in your pull request is one way to help your patch be considered faster. To learn about WordPress' test suites, visit the Automated Testing page in the handbook.

If you have not had a chance, please review the Contribute with Code page in the WordPress Core Handbook.

The Developer Hub also documents the various coding standards that are followed:

Thank you,
The WordPress Project

gziolo · 2024-01-03T09:25:23Z

Resharing my WordPress/gutenberg#57234 (comment) from the issue in the Gutenberg repository. I propose that we remove the handling for the missing asset file and provide the default values instead. To land this patch, the required changes would be removing the proposed filter, and the _doing_it_wrong handling. It would be great to add a unit test that covers the case when there is no asset file provided.

Signed-off-by: Joe Fusco <[email protected]>

colorful-tones · 2024-01-05T15:53:16Z

It looks like unit tests are failing. I do not have the knowledge to fix or write 'em. Would it be necessary for merging, and could we have a separate follow-up PR to address the tests @gziolo ?

colorful-tones · 2024-01-05T15:54:17Z

Also, would it be easier to move this patch to be against the Gutenberg repo?

Signed-off-by: Joe Fusco <[email protected]>

josephfusco · 2024-01-05T19:07:11Z

A lot of the failing tests were fixed with 5c67d33, however there are still a few tests failing but seem unrelated.

Also, would it be easier to move this patch to be against the Gutenberg repo?

If the code for register_block_script_handle is sourced from outside of wordpress-develop, I'm happy to move this patch there.

gziolo

Thank you for iterations. All changes need to get applied in WordPress core.

src/wp-includes/blocks.php

tests/phpunit/tests/blocks/register.php

src/wp-includes/blocks.php

Signed-off-by: Joe Fusco <[email protected]>

colorful-tones · 2024-01-10T17:49:00Z

Nice progress here @josephfusco ! 🕺

github-actions · 2024-02-07T12:54:55Z

The following accounts have interacted with this PR and/or linked issues. I will continue to update these lists as activity occurs. You can also manually ask me to refresh this list by adding the props-bot label.

Core SVN

Core Committers: Use this line as a base for the props when committing in SVN:

Props joefusco, gziolo, spacedmonkey, colorful-tones.

GitHub Merge commits

If you're merging code through a pull request on GitHub, copy and paste the following into the bottom of the merge commit message.

Co-authored-by: josephfusco <[email protected]>
Co-authored-by: gziolo <[email protected]>
Co-authored-by: spacedmonkey <[email protected]>
Co-authored-by: colorful-tones <[email protected]>

To understand the WordPress project's expectations around crediting contributors, please review the Contributor Attribution page in the Core Handbook.

tests/phpunit/tests/blocks/register.php

src/wp-includes/blocks.php

See WordPress#5799 / https://core.trac.wordpress.org/ticket/60460

gziolo

Updating code directly on GitHub isn't the best idea after all 😅

The good news is that it's ready to go!

gziolo · 2024-02-08T08:20:22Z

Committed with https://core.trac.wordpress.org/changeset/57559.

See WordPress#5799 / https://core.trac.wordpress.org/ticket/60460

colorful-tones · 2024-02-08T10:04:56Z

Thanks for getting this over the line @gziolo and thanks @josephfusco for kicking it off 🙌

josephfusco closed this Dec 19, 2023

josephfusco reopened this Dec 19, 2023

josephfusco marked this pull request as ready for review December 19, 2023 20:28

josephfusco mentioned this pull request Dec 19, 2023

Migrate WordPress block asset files from PHP to JSON format wpengine/faustjs#1656

Merged

3 tasks

colorful-tones mentioned this pull request Dec 19, 2023

Consider filter for allowing block asset registration index.asset.php optional WordPress/gutenberg#57234

Closed

Gracefully handle scenarios where *.asset.php is absent

837931e

Signed-off-by: Joe Fusco <[email protected]>

josephfusco force-pushed the asset.php-unnecessary-doing-it-wrong branch from 0fa43f5 to 837931e Compare January 4, 2024 21:34

josephfusco added 3 commits January 4, 2024 17:20

Add test coverage

36d3af1

Signed-off-by: Joe Fusco <[email protected]>

Linting issues

1142150

Signed-off-by: Joe Fusco <[email protected]>

Correct linting issue

511c6f1

Signed-off-by: Joe Fusco <[email protected]>

Remove _doing_it_wrong check

5c67d33

Signed-off-by: Joe Fusco <[email protected]>

gziolo reviewed Jan 5, 2024

View reviewed changes

src/wp-includes/blocks.php Outdated Show resolved Hide resolved

tests/phpunit/tests/blocks/register.php Show resolved Hide resolved

tests/phpunit/tests/blocks/register.php Outdated Show resolved Hide resolved

gziolo reviewed Jan 5, 2024

View reviewed changes

src/wp-includes/blocks.php Outdated Show resolved Hide resolved

spacedmonkey requested changes Jan 6, 2024

View reviewed changes

src/wp-includes/blocks.php Outdated Show resolved Hide resolved

josephfusco added 4 commits January 8, 2024 11:59

Remove early return

f3fad9e

Signed-off-by: Joe Fusco <[email protected]>

Reduce complexities

21c52a5

Signed-off-by: Joe Fusco <[email protected]>

Test for return of expected handle

7219bde

Signed-off-by: Joe Fusco <[email protected]>

Resolve whitespace linting issues

c9d758b

Signed-off-by: Joe Fusco <[email protected]>

josephfusco requested review from gziolo and spacedmonkey January 8, 2024 17:36

Update tests

610a40a

Signed-off-by: Joe Fusco <[email protected]>

sirreal mentioned this pull request Feb 6, 2024

Add viewScriptModule handling to block.json metadata #5860

Closed

Fix unit test failures

543274b

gziolo reviewed Feb 7, 2024

View reviewed changes

tests/phpunit/tests/blocks/register.php Outdated Show resolved Hide resolved

gziolo added 6 commits February 7, 2024 14:09

Update tests/phpunit/tests/blocks/register.php

0847e7d

Delete tests/phpunit/data/blocks/no-asset-php/block-rtl.css

5c4bb72

Delete tests/phpunit/data/blocks/no-asset-php/block.json

081e4fc

Delete tests/phpunit/data/blocks/no-asset-php/render.php

9af46c5

Delete tests/phpunit/data/blocks/no-asset-php/block.js

ffd38f9

Delete tests/phpunit/data/blocks/no-asset-php/block.css

2f16a53

gziolo reviewed Feb 7, 2024

View reviewed changes

src/wp-includes/blocks.php Outdated Show resolved Hide resolved

Update src/wp-includes/blocks.php

8cfe4fc

gziolo changed the title ~~Update blocks.php~~ Editor: Make asset registration .asset.php optional for blocks Feb 7, 2024

Update register.php

267f49c

sirreal added a commit to sirreal/wordpress-develop that referenced this pull request Feb 7, 2024

Make module asset file optional

0f5f26d

See WordPress#5799 / https://core.trac.wordpress.org/ticket/60460

sirreal added a commit to sirreal/wordpress-develop that referenced this pull request Feb 7, 2024

Make module asset file optional

7b197fa

See WordPress#5799 / https://core.trac.wordpress.org/ticket/60460

gziolo added 3 commits February 8, 2024 06:58

Fix the failures reported for PHP 8

c000be1

Update blocks.php

e362c64

Update blocks.php

c3edb3d

gziolo approved these changes Feb 8, 2024

View reviewed changes

gziolo closed this Feb 8, 2024

sirreal added a commit to sirreal/wordpress-develop that referenced this pull request Feb 8, 2024

Make module asset file optional

862a928

See WordPress#5799 / https://core.trac.wordpress.org/ticket/60460

sirreal added a commit to sirreal/wordpress-develop that referenced this pull request Feb 8, 2024

Make module asset file optional

2d3a37f

See WordPress#5799 / https://core.trac.wordpress.org/ticket/60460

theodesp mentioned this pull request May 29, 2024

Blocks not showing up in Wordpress editor wpengine/faustjs#1880

Closed

1 task

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Editor: Make asset registration .asset.php optional for blocks #5799

Editor: Make asset registration .asset.php optional for blocks #5799

josephfusco commented Dec 19, 2023 •

edited by gziolo

Loading

github-actions bot commented Dec 19, 2023

github-actions bot commented Dec 19, 2023

gziolo commented Jan 3, 2024

colorful-tones commented Jan 5, 2024

colorful-tones commented Jan 5, 2024

josephfusco commented Jan 5, 2024

gziolo left a comment

colorful-tones commented Jan 10, 2024

github-actions bot commented Feb 7, 2024

gziolo left a comment

gziolo commented Feb 8, 2024

colorful-tones commented Feb 8, 2024

Editor: Make asset registration .asset.php optional for blocks #5799

Editor: Make asset registration .asset.php optional for blocks #5799

Conversation

josephfusco commented Dec 19, 2023 • edited by gziolo Loading

github-actions bot commented Dec 19, 2023

Test using WordPress Playground

Some things to be aware of

github-actions bot commented Dec 19, 2023

gziolo commented Jan 3, 2024

colorful-tones commented Jan 5, 2024

colorful-tones commented Jan 5, 2024

josephfusco commented Jan 5, 2024

gziolo left a comment

Choose a reason for hiding this comment

colorful-tones commented Jan 10, 2024

github-actions bot commented Feb 7, 2024

Core SVN

GitHub Merge commits

gziolo left a comment

Choose a reason for hiding this comment

gziolo commented Feb 8, 2024

colorful-tones commented Feb 8, 2024

josephfusco commented Dec 19, 2023 •

edited by gziolo

Loading